﻿' ******************************************************************************
' ** 
' **  Yahoo Finance Managed
' **  Written by Marius Häusler 2010
' **  It would be pleasant, if you contact me when you are using this code.
' **  Contact: YahooFinanceManaged@gmail.com
' **  Project Home: http://code.google.com/p/yahoo-finance-managed/
' **  
' ******************************************************************************
' **  
' **  Copyright 2010 Marius Häusler
' **  
' **  Licensed under the Apache License, Version 2.0 (the "License");
' **  you may not use this file except in compliance with the License.
' **  You may obtain a copy of the License at
' **  
' **    http://www.apache.org/licenses/LICENSE-2.0
' **  
' **  Unless required by applicable law or agreed to in writing, software
' **  distributed under the License is distributed on an "AS IS" BASIS,
' **  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
' **  See the License for the specific language governing permissions and
' **  limitations under the License.
' ** 
' ******************************************************************************


Namespace Finance.Support

    ''' <summary>
    ''' Stores informations about a country. Serializable. 
    ''' </summary>
    ''' <remarks></remarks>
    <Serializable()> _
    Public Class CountryInfo
        Private mID As Country = Country.US
        Private mCurrency As Currency = Finance.Currency.AED
        Private mName As String = String.Empty
        Private mIndices(-1) As Support.YIndexID

        ''' <summary>
        ''' The country ID.
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property ID() As Country
            Get
                Return mID
            End Get
            Set(ByVal value As Country)
                mID = value
            End Set
        End Property
        ''' <summary>
        ''' The currency of this country
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property Currency() As Currency
            Get
                Return mCurrency
            End Get
            Set(ByVal value As Currency)
                mCurrency = value
            End Set
        End Property
        ''' <summary>
        ''' The name of the country
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public Property Name() As String
            Get
                Return mName
            End Get
            Set(ByVal value As String)
                mName = value
            End Set
        End Property
        ''' <summary>
        '''The indices in the country
        ''' </summary>
        ''' <value></value>
        ''' <returns></returns>
        ''' <remarks></remarks>
        Public ReadOnly Property Indices() As Support.YIndexID()
            Get
                Return mIndices
            End Get
        End Property

        Public Sub New(ByVal id As Country, ByVal cur As Currency, ByVal name As String)
            mID = id
            mCurrency = cur
            mName = name
        End Sub
        Public Sub New(ByVal id As Country, ByVal cur As Currency, ByVal name As String, ByVal indices() As Support.YIndexID)
            Me.New(Country.ID, cur, name)
            mIndices = indices
        End Sub

    End Class

End Namespace